<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width">
  <meta name="nodejs.org:node-version" content="v14.19.1">
  <title>C++ embedder API | Node.js v14.19.1 Documentation</title>
  <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback">
  <link rel="stylesheet" href="assets/style.css">
  <link rel="stylesheet" href="assets/hljs.css">
  <link rel="canonical" href="https://nodejs.org/api/embedding.html">
</head>
<body class="alt apidoc" id="api-section-embedding">
  <div id="content" class="clearfix">
    <div id="column2" class="interior">
      <div id="intro" class="interior">
        <a href="/" title="Go back to the home page">
          Node.js
        </a>
      </div>
      <ul>
<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li>
<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li>
</ul>
<hr class="line">
<ul>
<li><a href="assert.html" class="nav-assert">Assertion testing</a></li>
<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li>
<li><a href="buffer.html" class="nav-buffer">Buffer</a></li>
<li><a href="addons.html" class="nav-addons">C++ addons</a></li>
<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li>
<li><a href="embedding.html" class="nav-embedding active">C++ embedder API</a></li>
<li><a href="child_process.html" class="nav-child_process">Child processes</a></li>
<li><a href="cluster.html" class="nav-cluster">Cluster</a></li>
<li><a href="cli.html" class="nav-cli">Command-line options</a></li>
<li><a href="console.html" class="nav-console">Console</a></li>
<li><a href="corepack.html" class="nav-corepack">Corepack</a></li>
<li><a href="crypto.html" class="nav-crypto">Crypto</a></li>
<li><a href="debugger.html" class="nav-debugger">Debugger</a></li>
<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li>
<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li>
<li><a href="dns.html" class="nav-dns">DNS</a></li>
<li><a href="domain.html" class="nav-domain">Domain</a></li>
<li><a href="errors.html" class="nav-errors">Errors</a></li>
<li><a href="events.html" class="nav-events">Events</a></li>
<li><a href="fs.html" class="nav-fs">File system</a></li>
<li><a href="globals.html" class="nav-globals">Globals</a></li>
<li><a href="http.html" class="nav-http">HTTP</a></li>
<li><a href="http2.html" class="nav-http2">HTTP/2</a></li>
<li><a href="https.html" class="nav-https">HTTPS</a></li>
<li><a href="inspector.html" class="nav-inspector">Inspector</a></li>
<li><a href="intl.html" class="nav-intl">Internationalization</a></li>
<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li>
<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li>
<li><a href="module.html" class="nav-module">Modules: <code>module</code> API</a></li>
<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li>
<li><a href="net.html" class="nav-net">Net</a></li>
<li><a href="os.html" class="nav-os">OS</a></li>
<li><a href="path.html" class="nav-path">Path</a></li>
<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li>
<li><a href="policy.html" class="nav-policy">Policies</a></li>
<li><a href="process.html" class="nav-process">Process</a></li>
<li><a href="punycode.html" class="nav-punycode">Punycode</a></li>
<li><a href="querystring.html" class="nav-querystring">Query strings</a></li>
<li><a href="readline.html" class="nav-readline">Readline</a></li>
<li><a href="repl.html" class="nav-repl">REPL</a></li>
<li><a href="report.html" class="nav-report">Report</a></li>
<li><a href="stream.html" class="nav-stream">Stream</a></li>
<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li>
<li><a href="timers.html" class="nav-timers">Timers</a></li>
<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li>
<li><a href="tracing.html" class="nav-tracing">Trace events</a></li>
<li><a href="tty.html" class="nav-tty">TTY</a></li>
<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li>
<li><a href="url.html" class="nav-url">URL</a></li>
<li><a href="util.html" class="nav-util">Utilities</a></li>
<li><a href="v8.html" class="nav-v8">V8</a></li>
<li><a href="vm.html" class="nav-vm">VM</a></li>
<li><a href="wasi.html" class="nav-wasi">WASI</a></li>
<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li>
<li><a href="zlib.html" class="nav-zlib">Zlib</a></li>
</ul>
<hr class="line">
<ul>
<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li>
</ul>
    </div>

    <div id="column1" data-id="embedding" class="interior">
      <header>
        <div class="header-container">
          <h1>Node.js v14.19.1 documentation</h1>
          <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden>
            <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24">
              <path fill="none" d="M0 0h24v24H0z" />
              <path d="M11.1 12.08c-2.33-4.51-.5-8.48.53-10.07C6.27 2.2 1.98 6.59 1.98 12c0 .14.02.28.02.42.62-.27 1.29-.42 2-.42 1.66 0 3.18.83 4.1 2.15A4.01 4.01 0 0111 18c0 1.52-.87 2.83-2.12 3.51.98.32 2.03.5 3.11.5 3.5 0 6.58-1.8 8.37-4.52-2.36.23-6.98-.97-9.26-5.41z"/>
              <path d="M7 16h-.18C6.4 14.84 5.3 14 4 14c-1.66 0-3 1.34-3 3s1.34 3 3 3h3c1.1 0 2-.9 2-2s-.9-2-2-2z"/>
            </svg>
            <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24">
              <path d="M0 0h24v24H0z" fill="none" />
              <path d="M6.76 4.84l-1.8-1.79-1.41 1.41 1.79 1.79 1.42-1.41zM4 10.5H1v2h3v-2zm9-9.95h-2V3.5h2V.55zm7.45 3.91l-1.41-1.41-1.79 1.79 1.41 1.41 1.79-1.79zm-3.21 13.7l1.79 1.8 1.41-1.41-1.8-1.79-1.4 1.4zM20 10.5v2h3v-2h-3zm-8-5c-3.31 0-6 2.69-6 6s2.69 6 6 6 6-2.69 6-6-2.69-6-6-6zm-1 16.95h2V19.5h-2v2.95zm-7.45-3.91l1.41 1.41 1.79-1.8-1.41-1.41-1.79 1.8z"/>
            </svg>
          </button>
        </div>
        <div id="gtoc">
          <ul>
            <li>
              <a href="index.html">Index</a>
            </li>
            <li>
              <a href="all.html">View on single page</a>
            </li>
            <li>
              <a href="embedding.json">View as JSON</a>
            </li>
            
    <li class="version-picker">
      <a href="#">View another version <span>&#x25bc;</span></a>
      <ol class="version-picker"><li><a href="https://nodejs.org/docs/latest-v17.x/api/embedding.html">17.x</a></li>
<li><a href="https://nodejs.org/docs/latest-v16.x/api/embedding.html">16.x <b>LTS</b></a></li>
<li><a href="https://nodejs.org/docs/latest-v15.x/api/embedding.html">15.x</a></li>
<li><a href="https://nodejs.org/docs/latest-v14.x/api/embedding.html">14.x <b>LTS</b></a></li></ol>
    </li>
  
            <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/master/doc/api/embedding.md">Edit on GitHub</a></li>
          </ul>
        </div>
        <hr>
      </header>

      <details id="toc" open><summary>Table of contents</summary><ul>
<li><a href="#embedding_c_embedder_api">C++ embedder API</a>
<ul>
<li><a href="#embedding_example_embedding_application">Example embedding application</a>
<ul>
<li><a href="#embedding_setting_up_per_process_state">Setting up per-process state</a></li>
<li><a href="#embedding_per_instance_state">Per-instance state</a></li>
</ul>
</li>
</ul>
</li>
</ul></details>

      <div id="apicontent">
        <h2>C++ embedder API<span><a class="mark" href="#embedding_c_embedder_api" id="embedding_c_embedder_api">#</a></span></h2>

<p>Node.js provides a number of C++ APIs that can be used to execute JavaScript
in a Node.js environment from other C++ software.</p>
<p>The documentation for these APIs can be found in <a href="https://github.com/nodejs/node/blob/HEAD/src/node.h">src/node.h</a> in the Node.js
source tree. In addition to the APIs exposed by Node.js, some required concepts
are provided by the V8 embedder API.</p>
<p>Because using Node.js as an embedded library is different from writing code
that is executed by Node.js, breaking changes do not follow typical Node.js
<a href="deprecations.html">deprecation policy</a> and may occur on each semver-major release without prior
warning.</p>
<section><h3>Example embedding application<span><a class="mark" href="#embedding_example_embedding_application" id="embedding_example_embedding_application">#</a></span></h3>
<p>The following sections will provide an overview over how to use these APIs
to create an application from scratch that will perform the equivalent of
<code>node -e &#x3C;code></code>, i.e. that will take a piece of JavaScript and run it in
a Node.js-specific environment.</p>
<p>The full code can be found <a href="https://github.com/nodejs/node/blob/HEAD/test/embedding/embedtest.cc">in the Node.js source tree</a>.</p>
<h4>Setting up per-process state<span><a class="mark" href="#embedding_setting_up_per_process_state" id="embedding_setting_up_per_process_state">#</a></span></h4>
<p>Node.js requires some per-process state management in order to run:</p>
<ul>
<li>Arguments parsing for Node.js <a href="cli.html">CLI options</a>,</li>
<li>V8 per-process requirements, such as a <code>v8::Platform</code> instance.</li>
</ul>
<p>The following example shows how these can be set up. Some class names are from
the <code>node</code> and <code>v8</code> C++ namespaces, respectively.</p>
<pre><code class="language-cpp"><span class="hljs-function"><span class="hljs-type">int</span> <span class="hljs-title">main</span><span class="hljs-params">(<span class="hljs-type">int</span> argc, <span class="hljs-type">char</span>** argv)</span> </span>{
  argv = <span class="hljs-built_in">uv_setup_args</span>(argc, argv);
  <span class="hljs-function">std::vector&#x3C;std::string> <span class="hljs-title">args</span><span class="hljs-params">(argv, argv + argc)</span></span>;
  std::vector&#x3C;std::string> exec_args;
  std::vector&#x3C;std::string> errors;
  <span class="hljs-comment">// Parse Node.js CLI options, and print any errors that have occurred while</span>
  <span class="hljs-comment">// trying to parse them.</span>
  <span class="hljs-type">int</span> exit_code = node::<span class="hljs-built_in">InitializeNodeWithArgs</span>(&#x26;args, &#x26;exec_args, &#x26;errors);
  <span class="hljs-keyword">for</span> (<span class="hljs-keyword">const</span> std::string&#x26; error : errors)
    <span class="hljs-built_in">fprintf</span>(stderr, <span class="hljs-string">"%s: %s\n"</span>, args[<span class="hljs-number">0</span>].<span class="hljs-built_in">c_str</span>(), error.<span class="hljs-built_in">c_str</span>());
  <span class="hljs-keyword">if</span> (exit_code != <span class="hljs-number">0</span>) {
    <span class="hljs-keyword">return</span> exit_code;
  }

  <span class="hljs-comment">// Create a v8::Platform instance. `MultiIsolatePlatform::Create()` is a way</span>
  <span class="hljs-comment">// to create a v8::Platform instance that Node.js can use when creating</span>
  <span class="hljs-comment">// Worker threads. When no `MultiIsolatePlatform` instance is present,</span>
  <span class="hljs-comment">// Worker threads are disabled.</span>
  std::unique_ptr&#x3C;MultiIsolatePlatform> platform =
      MultiIsolatePlatform::<span class="hljs-built_in">Create</span>(<span class="hljs-number">4</span>);
  V8::<span class="hljs-built_in">InitializePlatform</span>(platform.<span class="hljs-built_in">get</span>());
  V8::<span class="hljs-built_in">Initialize</span>();

  <span class="hljs-comment">// See below for the contents of this function.</span>
  <span class="hljs-type">int</span> ret = <span class="hljs-built_in">RunNodeInstance</span>(platform.<span class="hljs-built_in">get</span>(), args, exec_args);

  V8::<span class="hljs-built_in">Dispose</span>();
  V8::<span class="hljs-built_in">ShutdownPlatform</span>();
  <span class="hljs-keyword">return</span> ret;
}</code></pre>
<h4>Per-instance state<span><a class="mark" href="#embedding_per_instance_state" id="embedding_per_instance_state">#</a></span></h4>
<p>Node.js has a concept of a “Node.js instance”, that is commonly being referred
to as <code>node::Environment</code>. Each <code>node::Environment</code> is associated with:</p>
<ul>
<li>Exactly one <code>v8::Isolate</code>, i.e. one JS Engine instance,</li>
<li>Exactly one <code>uv_loop_t</code>, i.e. one event loop, and</li>
<li>A number of <code>v8::Context</code>s, but exactly one main <code>v8::Context</code>.</li>
<li>One <code>node::IsolateData</code> instance that contains information that could be
shared by multiple <code>node::Environment</code>s that use the same <code>v8::Isolate</code>.
Currently, no testing if performed for this scenario.</li>
</ul>
<p>In order to set up a <code>v8::Isolate</code>, an <code>v8::ArrayBuffer::Allocator</code> needs
to be provided. One possible choice is the default Node.js allocator, which
can be created through <code>node::ArrayBufferAllocator::Create()</code>. Using the Node.js
allocator allows minor performance optimizations when addons use the Node.js
C++ <code>Buffer</code> API, and is required in order to track <code>ArrayBuffer</code> memory in
<a href="process.html#process_process_memoryusage"><code>process.memoryUsage()</code></a>.</p>
<p>Additionally, each <code>v8::Isolate</code> that is used for a Node.js instance needs to
be registered and unregistered with the <code>MultiIsolatePlatform</code> instance, if one
is being used, in order for the platform to know which event loop to use
for tasks scheduled by the <code>v8::Isolate</code>.</p>
<p>The <code>node::NewIsolate()</code> helper function creates a <code>v8::Isolate</code>,
sets it up with some Node.js-specific hooks (e.g. the Node.js error handler),
and registers it with the platform automatically.</p>
<pre><code class="language-cpp"><span class="hljs-function"><span class="hljs-type">int</span> <span class="hljs-title">RunNodeInstance</span><span class="hljs-params">(MultiIsolatePlatform* platform,
                    <span class="hljs-keyword">const</span> std::vector&#x3C;std::string>&#x26; args,
                    <span class="hljs-keyword">const</span> std::vector&#x3C;std::string>&#x26; exec_args)</span> </span>{
  <span class="hljs-type">int</span> exit_code = <span class="hljs-number">0</span>;
  <span class="hljs-comment">// Set up a libuv event loop.</span>
  <span class="hljs-type">uv_loop_t</span> loop;
  <span class="hljs-type">int</span> ret = <span class="hljs-built_in">uv_loop_init</span>(&#x26;loop);
  <span class="hljs-keyword">if</span> (ret != <span class="hljs-number">0</span>) {
    <span class="hljs-built_in">fprintf</span>(stderr, <span class="hljs-string">"%s: Failed to initialize loop: %s\n"</span>,
            args[<span class="hljs-number">0</span>].<span class="hljs-built_in">c_str</span>(),
            <span class="hljs-built_in">uv_err_name</span>(ret));
    <span class="hljs-keyword">return</span> <span class="hljs-number">1</span>;
  }

  std::shared_ptr&#x3C;ArrayBufferAllocator> allocator =
      ArrayBufferAllocator::<span class="hljs-built_in">Create</span>();

  Isolate* isolate = <span class="hljs-built_in">NewIsolate</span>(allocator, &#x26;loop, platform);
  <span class="hljs-keyword">if</span> (isolate == <span class="hljs-literal">nullptr</span>) {
    <span class="hljs-built_in">fprintf</span>(stderr, <span class="hljs-string">"%s: Failed to initialize V8 Isolate\n"</span>, args[<span class="hljs-number">0</span>].<span class="hljs-built_in">c_str</span>());
    <span class="hljs-keyword">return</span> <span class="hljs-number">1</span>;
  }

  {
    <span class="hljs-function">Locker <span class="hljs-title">locker</span><span class="hljs-params">(isolate)</span></span>;
    <span class="hljs-function">Isolate::Scope <span class="hljs-title">isolate_scope</span><span class="hljs-params">(isolate)</span></span>;

    <span class="hljs-comment">// Create a node::IsolateData instance that will later be released using</span>
    <span class="hljs-comment">// node::FreeIsolateData().</span>
    <span class="hljs-function">std::unique_ptr&#x3C;IsolateData, <span class="hljs-title">decltype</span><span class="hljs-params">(&#x26;node::FreeIsolateData)</span>> <span class="hljs-title">isolate_data</span><span class="hljs-params">(
        node::CreateIsolateData(isolate, &#x26;loop, platform, allocator.get()),
        node::FreeIsolateData)</span></span>;

    <span class="hljs-comment">// Set up a new v8::Context.</span>
    <span class="hljs-function">HandleScope <span class="hljs-title">handle_scope</span><span class="hljs-params">(isolate)</span></span>;
    Local&#x3C;Context> context = node::<span class="hljs-built_in">NewContext</span>(isolate);
    <span class="hljs-keyword">if</span> (context.<span class="hljs-built_in">IsEmpty</span>()) {
      <span class="hljs-built_in">fprintf</span>(stderr, <span class="hljs-string">"%s: Failed to initialize V8 Context\n"</span>, args[<span class="hljs-number">0</span>].<span class="hljs-built_in">c_str</span>());
      <span class="hljs-keyword">return</span> <span class="hljs-number">1</span>;
    }

    <span class="hljs-comment">// The v8::Context needs to be entered when node::CreateEnvironment() and</span>
    <span class="hljs-comment">// node::LoadEnvironment() are being called.</span>
    <span class="hljs-function">Context::Scope <span class="hljs-title">context_scope</span><span class="hljs-params">(context)</span></span>;

    <span class="hljs-comment">// Create a node::Environment instance that will later be released using</span>
    <span class="hljs-comment">// node::FreeEnvironment().</span>
    <span class="hljs-function">std::unique_ptr&#x3C;Environment, <span class="hljs-title">decltype</span><span class="hljs-params">(&#x26;node::FreeEnvironment)</span>> <span class="hljs-title">env</span><span class="hljs-params">(
        node::CreateEnvironment(isolate_data.get(), context, args, exec_args),
        node::FreeEnvironment)</span></span>;

    <span class="hljs-comment">// Set up the Node.js instance for execution, and run code inside of it.</span>
    <span class="hljs-comment">// There is also a variant that takes a callback and provides it with</span>
    <span class="hljs-comment">// the `require` and `process` objects, so that it can manually compile</span>
    <span class="hljs-comment">// and run scripts as needed.</span>
    <span class="hljs-comment">// The `require` function inside this script does *not* access the file</span>
    <span class="hljs-comment">// system, and can only load built-in Node.js modules.</span>
    <span class="hljs-comment">// `module.createRequire()` is being used to create one that is able to</span>
    <span class="hljs-comment">// load files from the disk, and uses the standard CommonJS file loader</span>
    <span class="hljs-comment">// instead of the internal-only `require` function.</span>
    MaybeLocal&#x3C;Value> loadenv_ret = node::<span class="hljs-built_in">LoadEnvironment</span>(
        env.<span class="hljs-built_in">get</span>(),
        <span class="hljs-string">"const publicRequire ="</span>
        <span class="hljs-string">"  require('module').createRequire(process.cwd() + '/');"</span>
        <span class="hljs-string">"globalThis.require = publicRequire;"</span>
        <span class="hljs-string">"require('vm').runInThisContext(process.argv[1]);"</span>);

    <span class="hljs-keyword">if</span> (loadenv_ret.<span class="hljs-built_in">IsEmpty</span>())  <span class="hljs-comment">// There has been a JS exception.</span>
      <span class="hljs-keyword">return</span> <span class="hljs-number">1</span>;

    {
      <span class="hljs-comment">// SealHandleScope protects against handle leaks from callbacks.</span>
      <span class="hljs-function">SealHandleScope <span class="hljs-title">seal</span><span class="hljs-params">(isolate)</span></span>;
      <span class="hljs-type">bool</span> more;
      <span class="hljs-keyword">do</span> {
        <span class="hljs-built_in">uv_run</span>(&#x26;loop, UV_RUN_DEFAULT);

        <span class="hljs-comment">// V8 tasks on background threads may end up scheduling new tasks in the</span>
        <span class="hljs-comment">// foreground, which in turn can keep the event loop going. For example,</span>
        <span class="hljs-comment">// WebAssembly.compile() may do so.</span>
        platform-><span class="hljs-built_in">DrainTasks</span>(isolate);

        <span class="hljs-comment">// If there are new tasks, continue.</span>
        more = <span class="hljs-built_in">uv_loop_alive</span>(&#x26;loop);
        <span class="hljs-keyword">if</span> (more) <span class="hljs-keyword">continue</span>;

        <span class="hljs-comment">// node::EmitProcessBeforeExit() is used to emit the 'beforeExit' event</span>
        <span class="hljs-comment">// on the `process` object.</span>
        <span class="hljs-keyword">if</span> (node::<span class="hljs-built_in">EmitProcessBeforeExit</span>(env.<span class="hljs-built_in">get</span>()).<span class="hljs-built_in">IsNothing</span>())
          <span class="hljs-keyword">break</span>;

        <span class="hljs-comment">// 'beforeExit' can also schedule new work that keeps the event loop</span>
        <span class="hljs-comment">// running.</span>
        more = <span class="hljs-built_in">uv_loop_alive</span>(&#x26;loop);
      } <span class="hljs-keyword">while</span> (more == <span class="hljs-literal">true</span>);
    }

    <span class="hljs-comment">// node::EmitProcessExit() returns the current exit code.</span>
    exit_code = node::<span class="hljs-built_in">EmitProcessExit</span>(env.<span class="hljs-built_in">get</span>()).<span class="hljs-built_in">FromMaybe</span>(<span class="hljs-number">1</span>);

    <span class="hljs-comment">// node::Stop() can be used to explicitly stop the event loop and keep</span>
    <span class="hljs-comment">// further JavaScript from running. It can be called from any thread,</span>
    <span class="hljs-comment">// and will act like worker.terminate() if called from another thread.</span>
    node::<span class="hljs-built_in">Stop</span>(env.<span class="hljs-built_in">get</span>());
  }

  <span class="hljs-comment">// Unregister the Isolate with the platform and add a listener that is called</span>
  <span class="hljs-comment">// when the Platform is done cleaning up any state it had associated with</span>
  <span class="hljs-comment">// the Isolate.</span>
  <span class="hljs-type">bool</span> platform_finished = <span class="hljs-literal">false</span>;
  platform-><span class="hljs-built_in">AddIsolateFinishedCallback</span>(isolate, [](<span class="hljs-type">void</span>* data) {
    *<span class="hljs-built_in">static_cast</span>&#x3C;<span class="hljs-type">bool</span>*>(data) = <span class="hljs-literal">true</span>;
  }, &#x26;platform_finished);
  platform-><span class="hljs-built_in">UnregisterIsolate</span>(isolate);
  isolate-><span class="hljs-built_in">Dispose</span>();

  <span class="hljs-comment">// Wait until the platform has cleaned up all relevant resources.</span>
  <span class="hljs-keyword">while</span> (!platform_finished)
    <span class="hljs-built_in">uv_run</span>(&#x26;loop, UV_RUN_ONCE);
  <span class="hljs-type">int</span> err = <span class="hljs-built_in">uv_loop_close</span>(&#x26;loop);
  <span class="hljs-built_in">assert</span>(err == <span class="hljs-number">0</span>);

  <span class="hljs-keyword">return</span> exit_code;
}</code></pre></section>
        <!-- API END -->
      </div>
    </div>
  </div>
  <script>
    'use strict';
    {
      const kCustomPreference = 'customDarkTheme';
      const userSettings = sessionStorage.getItem(kCustomPreference);
      const themeToggleButton = document.getElementById('theme-toggle-btn');
      if (userSettings === null && window.matchMedia) {
        const mq = window.matchMedia('(prefers-color-scheme: dark)');
        if ('onchange' in mq) {
          function mqChangeListener(e) {
            document.body.classList.toggle('dark-mode', e.matches);
          }
          mq.addEventListener('change', mqChangeListener);
          if (themeToggleButton) {
            themeToggleButton.addEventListener('click', function() {
              mq.removeEventListener('change', mqChangeListener);
            }, { once: true });
          }
        }
        if (mq.matches) {
          document.body.classList.add('dark-mode');
        }
      } else if (userSettings === 'true') {
        document.body.classList.add('dark-mode');
      }
      if (themeToggleButton) {
        themeToggleButton.hidden = false;
        themeToggleButton.addEventListener('click', function() {
          sessionStorage.setItem(
            kCustomPreference,
            document.body.classList.toggle('dark-mode')
          );
        });
      }
    }
  </script>
</body>
</html>
